#region (c) 2014 THN Solutions LLC. - All rights reserved
/*
Simplified BSD License (BSD)
Copyright (c) 2014, THN Solutions LLC. ( www.ThnSolutions.com )
Author: Nguyễn, M. Hải                 ( www.Minh-Hai.com     )
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this 
      list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above copyright notice, 
      this list of conditions and the following disclaimer in the documentation 
      and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
#endregion

#region Record of Change
//             							CHANGE HISTORY
// -------------------------------------------------------------------------------------
// |   DATE    | DEVELOPER  | DESCRIPTION                                              |
// -------------------------------------------------------------------------------------
// | 10-Nov-09 | HuyHM      | First creation.                                          |
// -------------------------------------------------------------------------------------
//
#endregion

#region Record of Audit
//             							REVIEW HISTORY
// -------------------------------------------------------------------------------------
// |   DATE    | REVIEWER   | NOTES                                                    |
// -------------------------------------------------------------------------------------
// -------------------------------------------------------------------------------------
//
#endregion

#region Using directives
using System;
using System.Drawing;

using Thn;
#endregion

namespace Thn.Interface.Vcl
{
    /// <summary>
    /// Interface for control that content may bigger than container's size.
    /// It will show scroller auto by Renderer engine.
    /// </summary>
#if DEBUG 
    public
#else
    public
#endif 
    interface IScollable
    {
        #region To Scroll Viewer
        /// <summary>
        /// Gets/Sets viewer for this scrollable info.
        /// </summary>
        IScrollViewer Viewer { get; set; }
        #endregion

        #region Size and Position
        /// <summary>
        /// Get the total width of content.
        /// </summary>
        double ExtendWidth { get; }

        /// <summary>
        /// Get the total height of content.
        /// </summary>
        double ExtentHeight { get; }

        /// <summary>
        /// Width of viewport ( area that user can see).
        /// </summary>
        double ViewportWidth { get; }
        /// <summary>
        /// Height of viewport ( area that user can see).
        /// </summary>
        double ViewportHeight { get; }

        /// <summary>
        /// Current vertical offset.
        /// </summary>
        double VerticalOffset { get; }

        /// <summary>
        /// Current horizontal offset.
        /// </summary>
        double HorizontalOffset { get; }

        /// <summary>
        /// Visibility mode for horizontal scroller.
        /// </summary>
        ScrollerMode HorizontalScoller { get; }

        /// <summary>
        /// Visibility mode for vertical scroller.
        /// </summary>
        ScrollerMode VerticalScroller { get; }
        #endregion

        #region Method when moving
        #region Scroll by page
        /// <summary>
        /// Scroll up a page.
        /// </summary>
        void PageUp();

        /// <summary>
        /// Scroll down a page.
        /// </summary>
        void PageDown();

        /// <summary>
        /// Scroll left a page.
        /// </summary>
        void PageLeft();

        /// <summary>
        /// Scroll a page to right.
        /// </summary>
        void PageRight();
        #endregion

        #region Scroll by line
        /// <summary>
        /// Moving up by a line (a small change).
        /// </summary>
        void LineUp();

        /// <summary>
        /// Moving down by a line ( a small change).
        /// </summary>
        void LineDown();

        /// <summary>
        /// Moving left by a line ( a small change).
        /// </summary>
        void LineLeft();

        /// <summary>
        /// Moving right by a line ( a small change).
        /// </summary>
        void LineRight();
        #endregion

        #region Scroll by mouse wheel
        /// <summary>
        /// Moving up by mouse wheel.
        /// </summary>
        void MouseWheelUp();

        /// <summary>
        /// Moving down by mouse wheel.
        /// </summary>
        void MouseWheelDown();

        /// <summary>
        /// Moving left by mouse wheel.
        /// </summary>
        void MouseWheelLeft();

        /// <summary>
        /// Moving right by mouse wheel.
        /// </summary>
        void MouseWheelRight();
        #endregion

        #region Moving by offset
        /// <summary>
        /// Move to vertical position.
        /// </summary>
        /// <param name="offset">Vertical offset.</param>
        void SetVerticalOffset(double offset);

        /// <summary>
        /// Move to horizontal potition.
        /// </summary>
        /// <param name="offset">Offset</param>
        void SetHirizontalOffset(double offset);
        #endregion
        #endregion
    }
}
